home *** CD-ROM | disk | FTP | other *** search
Wrap
Text File | 1997-02-10 | 20.7 KB | 612 lines | [ TEXT/ttxt]
################################ # # File: Standard Setup # # Contains: Standard Guide Script commands for Apple Guide files # # Coded by: Glenn Katz and Shemin Gau # Modified by: Mizutori Tetsuya, January 23, 1997 # # Copyright: ©1994 by Apple Computer, Inc. # ################################ ################################ # How To Use This File ################################ # This file contains the Guide Script commands needed to setup a guide # file that follows the Apple Guide HI guidelines. # # This file is part a set of files that you will compile to create your # guide file. You will also need: # # • Build File - a file that points to all of the related source files # that define your guide file. # # • Content - a file that contains the actual text that appears on # the guide file panels. (As your guide file grows, it # may be helpful to break the Content file into several # smaller files). # # To use this file: # # 1. Edit this file to customize the standard setup for your guide # file. Most of the commands in this file can be used "as is," # but you'll want to change the <Help Menu>, <Balloon Menu Text>, # and <Version> commands to reflect your application's name. # # 2. Edit the Content file to define the content of your guide file. # # 3. Use the Guide Maker Build utility to compile the Build File # that points to all of the source files that define your guide # file. ################################ # Help Menu Appearance ################################ # First, you must specify how this guide file will appear in the Help # menu: the menu item name, the guide file type, and the command # key shortcut for quickly opening this file. # Modified by Mizutori #<Help Menu> "MyApplication Guide", HELP,"?" # You can also specify the text that will appear when balloon help is # used on this Help menu item. # Modified by Mizutori #<Balloon Menu Text> "Displays information and instructions you can use while working in the MyApplication." # If you want to restrict your guide file so that it only appears # in the Help menu for your application (and does not appear in the # Help menu for other applications located in the same folder), use # the following command. # <App Creator> 'XXXX' ################################ # Access Window Attributes ################################ # First, use this command to specify the type of window that Apple Guide # should display when your guide file is first opened. # # Syntax: <Startup Window> windowType , accessScreenOptions # # This command opens a Full access window (with three search modes - # Topics, Index, and Look For) to a welcoming Howdy screen. # Modified by Mizutori #<Startup Window> FULL, HOWDY # These are some of the other alternatives: # <Startup Window> FULL, TOPICS # <Startup Window> FULL, INDEX # <Startup Window> FULL, LOOKFOR # <Startup Window> SINGLE, HOWDY # <Startup Window> SINGLE, TOPICS # <Startup Window> PRESENTATION # If you specify a startup window that opens to Howdy screen, you must # also define the text that will be displayed on that screen. # Modified by Mizutori #<Howdy> "Howdy Text" #<Define Text Block> "Howdy Text" #To start, click Topics, Index, or Look For. # #Topics shows general categories, and Index lists keywords. #Look For lets you search for help according to keywords you type. #<End Text Block> # You can also specify a PICT image to be displayed in the logo region # at the top left corner of the access window. # # Color and B&W templates for the PICT image are included in the # Standard Resources file (at ID 501 & 502). To include your PICT # image in the guide file, replace these resources (at ID 501 & 502) # in the Standard Resources file, or use this command: #<App Logo> colorLogoFilename, B&WLogoFilename ################################ # Finder File Information ################################ # The following command specifies the version strings that appear in # the Finder Get Info dialog for your guide file. # # Syntax: <Version> longVers1BottomOfGetInfo, shortVers1ForFinderListViews # [, longVers2TopOfGetInfo] # Modified by Mizutori #<VERSION> "MyApplication Guide 1.0 ©1994 MyCompany Inc.", "1.0" ################################ # Prompt Set Definitions ################################ # You can specify strings which appear at the bottom of each panel # to prompt the user about how to proceed after reading it. # # The following commands create the standard Apple Guide prompts # recommended in the HI guidelines and used in Macintosh Guide. # # Syntax: <Define Prompt Set> promptSetName, promptFirstPanel, # promptMiddlePanel, promptLastPanel, # promptForPanelsWithControls <Define Prompt Set> "How Do I Prompts", "To begin, click the right arrow.", "Do this step, then click the right arrow.", "Do this step, then you’re done.", "Make your choice, then click the right arrow." <Define Prompt Set> "Standard Prompts", "Click the right arrow to continue.", "Click the right arrow to continue.", "——End——", "Make your choice, then click the right arrow." # One prompt set can be designated the <Default Prompt Set>. This set will # be used for all panels, except when you override it by using the # <Sequence Prompt Set> or <Panel Prompt> commands. # Modified by Mizutori #<Default Prompt Set> "How Do I Prompts" <Default Prompt Set> "Standard Prompts" ################################ # Navigation Bar Button Definitions ################################ # You can specify which buttons appear in the navigation bar for your # guide file and the event each button should trigger. # # The following commands create the standard Apple Guide navigation # bar buttons recommended in the HI guidelines. These commands use # PICT resources located in the Standard Resources file. # # Syntax: <Define Nav Button> buttonName, buttonUpPict, buttonDownPict, # dimmedButtonPict, buttonEvent # [, b&wUp] [, b&wDown] [, b&wDimmed] # The GoStart button returns the user to your guide file's access window <Define Nav Button> "GoStart",1103,1113,1123,GoStart() # The Huh? button opens another sequence containing additional information # to help the user proceed. The Huh? button is activated on a panel by # including the <Huh> command in its panel definition. <Define Nav Button> "Huh?",1101,1111,1121,DIMMABLE # For convenience, navigation bar buttons are grouped into named sets. # "Standard Nav Bar" includes the GoStart and Huh? buttons # # Syntax: <Define Nav Button Set> navButtonSetName [, leftNavButton] # [, midNavButton] [, rightNavButton] <Define Nav Button Set> "Standard Nav Bar","GoStart","Huh?" <Define Nav Button Set> "GoStart Only","GoStart" <Define Nav Button Set> "Huh? Only","Huh?" # One navigation button set can be designated the <Default Nav Button Set>. # This set will be used in all sequences, except when you override it # by including the <Sequence Nav Button Set> command in a sequence definition. <Default Nav Button Set> "Standard Nav Bar" ################################ # Panel Format Definitions ################################ # You can use <Format> commands to control the text attributes and # placement of items on panels in your guide file. # # The following commands define the standard formats recommended in # in the Apple Guide HI guidelines. # # Syntax: <Define Format> formatName, columnCoords [, txFnt] [, txSize] # [, txStyle] [, txColor] [, txAlign] [, alignPrompt] # The "Full" format uses the full panel width. It should be used on panels # that don't contain step-by-step instructions. <Define Format> "Full", Column(6,11,330), "Espy Serif", 10, PLAIN, ,Left, false # The "Tag" and "Body" formats set up a two column layout. The "Do This" tags # used extensively in Macintosh Guide use the "Tag" format. The instructions # are placed with the "Body" format. <Define Format> "Tag", Column(6,0,54), "Espy Sans Bold", 10, PLAIN, ,Right, false <Define Format> "Body", Column(6,65,330), "Espy Serif", 10, PLAIN, ,Left, true # The "ResetPen" format is useful for canceling the previous <Format> command # in a panel definition. Use this format when placing objects using the # Point(x,y) function to specify panel coordinates. <Define Format> "ResetPen",Column(0,0,330), , , , , , false # One format can be designated as the Default format. This format will # be used for all text in your guide file, except when you override it # by including another <Format>. <Default Format> "Full" ################################ # Panel Height Settings ################################ # You can specify a maximum panel height to ensure that some piece # of your application will always be visible beneath the panels. If # the elements you include in a panel definition make it taller than # the maximum height, the content will automatically be split into # two or more panels. <Max Height> 500 # Apple Guide panels automatically size themselves to be as small as # possible. You may want to set both a minimum and maximum panel height # to keep the panels from resizing (the Finder Shortcuts guide file # uses this effect). # <Min Height> 300 # <Max Height> 300 ################################ # Event Definitions ################################ # You can use the <Define Event> command to define an event function # for use with the following commands: <Standard Button>, <3D Button>, # <Define Nav Button>, <On Panel Create>, <On Panel Destroy>, # <On Panel Show>, and <On Panel Hide>. # # The following commands create the Apple Guide API events not built # into Guide Maker. These events are used by the standard navigation # bar buttons. # # Syntax: <Define Event> eventName, targetApp, eventClass, eventID # [, IOPTData] [, optKey] [, optData] <Define Event> "DoHuh", 's***', 'help', 'dhuh' <Define Event> "GoBack", 's***', 'help', 'gobk' <Define Event> "GoStart", 's***', 'help', 'stac' # The following commands define some additional events that use the # Apple Guide API. You can attach these events to buttons on your # panels or use the <On Panel Show> command to trigger them when # the panel is opened. # These events jump to the designated panel (first, last, next, or previous) # in the current sequence. # <Define Event> "GoFirst", 's***', 'help', 'gofp' # <Define Event> "GoLast", 's***', 'help', 'golp' # <Define Event> "GoPrevious", 's***', 'help', 'gopp' # <Define Event> "GoNext", 's***', 'help', 'gonp' # This command tells each animation object in the frontmost panel to animate # itself. A QuickTime™ movie is an example of an animation object. # <Define Event> "Animate", 's***', 'help', 'paan' # This event closes the frontmost Apple Guide window and passes control to # the next open Apple Guide window, or quits Apple Guide if no other windows are present. # <Define Event> "QuitFront", 's***', 'help', 'ktop' # You can also use the DoScript event to attach any AppleScript to a # button or any command that uses events. ################################ # Context Check Definitions ################################ # Context checks are used to dynamically adapt the sequence of panels # presented to match the context of the user. # # The following context check definitions are used in Macintosh Guide # and may also be useful for your guide file. These definitions use # external code modules located in the Standard Resources file. # # Syntax: <Define Context Check> contextCheckName, codeResSpec [, targetApp] # [, additionalParam] [, additionalParam] # [, ... ] #============================================ # From external code module 'SYST' (system) #============================================ # Checking if File Sharing is on or off # # 'SYST'--> system module # 'MACS'--> current application's signature # LONG:6--> 6 for case isFileSharing in resource file # LONG:0--> off; LONG:1--> on <DCC> "FileSharingOff", 'SYST', 'MACS', LONG:6, LONG:0 <DCC> "FileSharingOn", 'SYST', 'MACS', LONG:6, LONG:1 # Checking if Guess Access is off # # 'SYST'--> system module # 'MACS'--> current application's signature # LONG:10--> 10 for case isGuessAccess in resource file # LONG:0--> fill in words for fill byte <DCC> "GuestAccessOff", 'SYST', 'MACS', LONG:10, LONG:0 # Checking the bit depth of the monitor # # LONG:8--> 8 for case isMonitorBitDepth in resource file # LONG--> 4 for greater than the compared value # 6 for greater than or equal to the compared value # 2 for equal to the compared vale # LONG--> compared value, you can specify a value here or in the real context check call <DCC> "BitDepthGreaterThan", 'SYST', 'MACS', LONG:8, LONG:4, LONG <DCC> "BitDepthAtLeast", 'SYST', 'MACS', LONG:8, LONG:6, LONG <DCC> "isMonoChrome", 'SYST', 'MACS', LONG:8, LONG:2, LONG:1 # Checking the number of monitors # # LONG:11--> 11 for case isNumberMonitors in resource file # LONG:4--> 4 for greater than the compared value # LONG:1--> compared value <DCC> "MultipleMonitors", 'SYST', 'MACS', LONG:11, LONG:4, LONG:1 # Checking if a menu item exists,or has checked mark # # LONG:1--> 1 for case menuItemExists in resource file # 2 for case menuItemMarked in resource file # LONG:0--> fill in a long for fill byte # LONG:10--> 10 for the string parameter matches the menu name # LPSTRING--> the string parameter for comparing with menu name # LONG--> 10 for the string parameter matches the menu item name # 8 for the string parameter contains anything # LPSTRING--> the string parameter for comparing with menu item name <DCC> "IsMenuExists", 'SYST', 'MACS', LONG:1, LONG:0, LONG:10, LPSTRING, LONG:8, LPSTRING <DCC> "IsMenuItemExists", 'SYST', 'MACS', LONG:2, LONG:0, LONG:10, LPSTRING, LONG:10, LPSTRING <DCC> "IsMenuItemChecked", 'SYST', 'MACS', LONG:2, LONG:0, LONG:10, LPSTRING, LONG:10, LPSTRING <DCC> "CDMenuItemExists", 'SYST', 'aucd', LONG:2, LONG:0, LONG:10, LPSTRING, LONG:10, LPSTRING # Checking the processor type # # LONG:0--> for case gestaltCheck in resource file # OSTYOE:'proc'--> the Gestalt selector you want to use, in this case, it's 'proc' # LONG--> 5 for less than; 7 for less than or equal to; 3 for not equal to; 2 for equal to # SHORT:0--> fill in a short for fill byte # LONG--> gestalt compare value <DCC> "CPUIs68040", 'SYST', 'MACS', LONG:0, OSTYPE:'proc', LONG:5, SHORT:0, LONG:2 <DCC> "CPU030orGreater", 'SYST', 'MACS', LONG:0, OSTYPE:'proc', LONG:6, SHORT:0, LONG:4 <DCC> "CPU68kArch", 'SYST', 'MACS', LONG:0, OSTYPE:'proc', LONG:7, SHORT:0, LONG:5 <DCC> "CPUIs68000", 'SYST', 'MACS', LONG:0, OSTYPE:'proc', LONG:3, SHORT:0, LONG:5 <DCC> "CPU1bitQD", 'SYST', 'MACS', LONG:0, OSTYPE:'qd ', LONG:2, SHORT:0, LONG:0x000 # Others <DCC> "NetworkName", 'SYST', 'MACS', LONG:9, LONG:0, LONG:8 #============================================ # From external code module 'File' #============================================ # Checking if a named file is in a special type folder, for instances: # Extensions, Apple Menu Folder, and so on # # 'FILE'--> file module # 'MACS'--> current application's signature # LONG:9--> 9 for case isFileExists in resource file # OSTYPE:'extn'--> specify the type of file; if it's an init indicate 'extn'; # if it's a control panel indicate 'ctrl', and so on. # LONG:0--> fill in a long for fill byte # LPSTRING--> will be the name of the file you want to check # example usage: InControlPanelFolder("Sharing Setup") <DCC> "InExtensions", 'FILE', 'MACS', LONG:9, OSTYPE:'extn', LONG:0, LPSTRING <DCC> "InSystemFolder", 'FILE', 'MACS', LONG:9, OSTYPE:'macs', LONG:0, LPSTRING <DCC> "InAppleMenuFolder", 'FILE', 'MACS', LONG:9, OSTYPE:'amnu', LONG:0, LPSTRING <DCC> "InControlPanelFolder", 'FILE', 'MACS', LONG:9, OSTYPE:'ctrl', LONG:0, LPSTRING <DCC> "AppleShareInstalled", 'FILE', 'MACS', LONG:9, OSTYPE:'extn', LONG:0, LPSTRING:"AppleShare" <DCC> "PrintMonitorInstalled", 'FILE', 'MACS', LONG:9, OSTYPE:'extn', LONG:0, LPSTRING:"PrintMonitor" <DCC> "GXInstalled", 'FILE', 'MACS', LONG:9, OSTYPE:'extn', LONG:0, LPSTRING:"QuickDraw™ GX" <DCC> "RamDiskExists", 'FILE', 'MACS', LONG:9, OSTYPE:'desk', LONG:0, LPSTRING:"Ram Disk" # 'FILE'--> file module # 'MACS'--> current application's signature # LONG:0--> for case isFrontStartUp in resource file <DCC> "BootDiskWinActive", 'FILE', 'MACS', LONG:0 # 'FILE'--> file module # 'MACS'--> current application's signature # LONG:1--> for case isOpenStartUp in resource file <DCC> "BootDiskWinOpen", 'FILE', 'MACS', LONG:1 # Others <DCC> "ControlPanelWinActive", 'FILE', 'MACS', OSTYPE:'ctrl', LONG:0 <DCC> "SystemFolderWinActive", 'FILE', 'MACS', OSTYPE:'macs', LONG:0 <DCC> "AppleMenuWinActive", 'FILE', 'MACS', OSTYPE:'amnu', LONG:0 <DCC> "ExtensionsWinActive", 'FILE', 'MACS', OSTYPE:'extn', LONG:0 <DCC> "AppleMenuWinOpen", 'FILE', 'MACS', OSTYPE:'amnu', LONG:1 <DCC> "ExtensionsWinOpen", 'FILE', 'MACS', OSTYPE:'extn', LONG:1 #============================================ # From external code module 'WIND' (window) #============================================ # Checking if a named window is open or active # # 'WIND'--> window module # 'MACS'--> current application's signature, if do not specify # the signature here, you'll need to specify it in the # actual context check call # LONG:--> 0 for case isFront in resource file, which means the # window is the frontmost (active) one # 1 for case isOpen in resource file, which means the window is open # 3 for case isShareWindowActive # LONG:0--> fill in a long for fill byte # LONG:--> 10 for the window name exactly matches the string parameter # 11 for window name contains the string parameter # 8 for window name contains any string parameter # LPSTRING--> will be the name of the window you want to check # example usage: OpenWindow('MACS',"Sharing Setup") <DCC> "OpenWindow", 'WIND', , LONG:1, LONG:0, LONG:10, LPSTRING <DCC> "OpenWindowIsInfo", 'WIND','MACS', LONG:1, LONG:0, LONG:11, LPSTRING:"Info" <DCC> "ActiveWindow", 'WIND', , LONG:0, LONG:0, LONG:10, LPSTRING <DCC> "ActiveWindowIsInfo", 'WIND','MACS', LONG:0, LONG:0, LONG:11, LPSTRING:"Info" <DCC> "AnyActiveWindow", 'WIND','MACS', LONG:0, LONG:0, LONG:8 <DCC> "ActiveWindowIsSharing" , 'WIND', 'MACS', LONG:3 # Others <DCC> "FindActive", 'WIND', 'MACS', LONG:3 <DCC> "FindMoreActive", 'WIND', 'MACS', LONG:4 #============================================ # From external code module 'CHSR' (chooser) #============================================ # 'CHSR'--> chooser module # 'MACS'--> current application's signature # LONG:4 --> for case isPrinterType in resource file # LONG:0--> fill in a long for fill byte # LONG:10--> the string parameter matches the printer name # LPSTRING --> the name of the printer you want to check <DCC> "SelectedPrinter", 'CHSR', 'MACS', LONG:4, LONG:0, LONG:10, LPSTRING # LONG:0 --> for case isPrinterDirect in resource file <DCC> "DirectConnectPrinter", 'CHSR', 'MACS', LONG:0 # Others <DCC> "AppleTalkOff", 'CHSR', 'MACS', LONG:5, LONG:0 <DCC> "NetworkPrinter", 'CHSR', 'MACS', LONG:1, LONG:6, LONG:1 <DCC> "NetworkHasZones", 'CHSR', 'MACS', LONG:9 <DCC> "NoSelectedPrinter", 'CHSR', 'MACS', LONG:4, LONG:0, LONG:9, LPSTRING #============================================ # From external code module 'PCSS' (process) #============================================ # 'PCSS'--> process module # 'MACS'--> pass 'MACS' # LONG--> 0 for the specified app is active; 1 for the window(s) # of the specified app is active # OSTYPE--> pass the application's signature # example usage: ActiveAppIs('fndf') <DCC> "ActiveAppIs",'PCSS','MACS', LONG:0,OSTYPE <DCC> "OpenAppIs",'PCSS','MACS', LONG:1,OSTYPE #============================================ # From external code module 'DLOG' (dialog) #============================================ <DCC> "ActiveDialog", 'DLOG', 'MACS', LONG:0, LONG <DCC> "AnyActiveDialog", 'DLOG', 'aucd', LONG:5 #============================================ # From external code module 'DTPr' (desktop printer) #============================================ <DCC> "IsThereDTPrinter", 'DTPr',FRONT #============================================ # From external code module 'Pddm' (PDD maker) #============================================ <DCC> "IsItPDDMaker", 'Pddm', FRONT, PSTRING